Meshtastic App/com.geeksville.mesh/[androidJvm]AdminProtos/AdminMessage/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , AdminProtos.AdminMessageOrBuilder


This message is handled by the Admin module and is responsible for all settings/channel read/write operations.
This message is used to do settings operations to both remote AND local nodes.
(Prior to 1.2 these operations were done via special ToRadio operations)

Protobuf type meshtastic.AdminMessage

Functions

build

open fun build(): AdminProtos.AdminMessage

buildPartial

open fun buildPartial(): AdminProtos.AdminMessage

clear

open fun clear(): AdminProtos.AdminMessage.Builder

clearAddContact

open fun clearAddContact(): AdminProtos.AdminMessage.Builder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

clearBackupPreferences

open fun clearBackupPreferences(): AdminProtos.AdminMessage.Builder


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

clearBeginEditSettings

open fun clearBeginEditSettings(): AdminProtos.AdminMessage.Builder


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

clearCommitEditSettings

open fun clearCommitEditSettings(): AdminProtos.AdminMessage.Builder


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

clearDeleteFileRequest

open fun clearDeleteFileRequest(): AdminProtos.AdminMessage.Builder


Delete the file by the specified path from the device

string delete_file_request = 22;

clearEnterDfuModeRequest

open fun clearEnterDfuModeRequest(): AdminProtos.AdminMessage.Builder


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

clearExitSimulator

open fun clearExitSimulator(): AdminProtos.AdminMessage.Builder


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

clearFactoryResetConfig

open fun clearFactoryResetConfig(): AdminProtos.AdminMessage.Builder


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

clearFactoryResetDevice

open fun clearFactoryResetDevice(): AdminProtos.AdminMessage.Builder


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

clearGetCannedMessageModuleMessagesRequest

open fun clearGetCannedMessageModuleMessagesRequest(): AdminProtos.AdminMessage.Builder


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

clearGetCannedMessageModuleMessagesResponse

open fun clearGetCannedMessageModuleMessagesResponse(): AdminProtos.AdminMessage.Builder


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

clearGetChannelRequest

open fun clearGetChannelRequest(): AdminProtos.AdminMessage.Builder


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

clearGetChannelResponse

open fun clearGetChannelResponse(): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

clearGetConfigRequest

open fun clearGetConfigRequest(): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

clearGetConfigResponse

open fun clearGetConfigResponse(): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

clearGetDeviceConnectionStatusRequest

open fun clearGetDeviceConnectionStatusRequest(): AdminProtos.AdminMessage.Builder


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

clearGetDeviceConnectionStatusResponse

open fun clearGetDeviceConnectionStatusResponse(): AdminProtos.AdminMessage.Builder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

clearGetDeviceMetadataRequest

open fun clearGetDeviceMetadataRequest(): AdminProtos.AdminMessage.Builder


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

clearGetDeviceMetadataResponse

open fun clearGetDeviceMetadataResponse(): AdminProtos.AdminMessage.Builder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

clearGetModuleConfigRequest

open fun clearGetModuleConfigRequest(): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

clearGetModuleConfigResponse

open fun clearGetModuleConfigResponse(): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

clearGetNodeRemoteHardwarePinsRequest

open fun clearGetNodeRemoteHardwarePinsRequest(): AdminProtos.AdminMessage.Builder


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

clearGetNodeRemoteHardwarePinsResponse

open fun clearGetNodeRemoteHardwarePinsResponse(): AdminProtos.AdminMessage.Builder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

clearGetOwnerRequest

open fun clearGetOwnerRequest(): AdminProtos.AdminMessage.Builder


Send the current owner data in the response to this message.

bool get_owner_request = 3;

clearGetOwnerResponse

open fun clearGetOwnerResponse(): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

clearGetRingtoneRequest

open fun clearGetRingtoneRequest(): AdminProtos.AdminMessage.Builder


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

clearGetRingtoneResponse

open fun clearGetRingtoneResponse(): AdminProtos.AdminMessage.Builder


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

clearGetUiConfigRequest

open fun clearGetUiConfigRequest(): AdminProtos.AdminMessage.Builder


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

clearGetUiConfigResponse

open fun clearGetUiConfigResponse(): AdminProtos.AdminMessage.Builder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

clearKeyVerification

open fun clearKeyVerification(): AdminProtos.AdminMessage.Builder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

clearNodedbReset

open fun clearNodedbReset(): AdminProtos.AdminMessage.Builder


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

clearPayloadVariant

open fun clearPayloadVariant(): AdminProtos.AdminMessage.Builder

clearRebootOtaSeconds

open fun clearRebootOtaSeconds(): AdminProtos.AdminMessage.Builder


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

clearRebootSeconds

open fun clearRebootSeconds(): AdminProtos.AdminMessage.Builder


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

clearRemoveBackupPreferences

open fun clearRemoveBackupPreferences(): AdminProtos.AdminMessage.Builder


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

clearRemoveByNodenum

open fun clearRemoveByNodenum(): AdminProtos.AdminMessage.Builder


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

clearRemoveFavoriteNode

open fun clearRemoveFavoriteNode(): AdminProtos.AdminMessage.Builder


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

clearRemoveFixedPosition

open fun clearRemoveFixedPosition(): AdminProtos.AdminMessage.Builder


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

clearRemoveIgnoredNode

open fun clearRemoveIgnoredNode(): AdminProtos.AdminMessage.Builder


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

clearRestorePreferences

open fun clearRestorePreferences(): AdminProtos.AdminMessage.Builder


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

clearSendInputEvent

open fun clearSendInputEvent(): AdminProtos.AdminMessage.Builder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

clearSessionPasskey

open fun clearSessionPasskey(): AdminProtos.AdminMessage.Builder


The node generates this key and sends it with any get_x_response packets.
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
Prevents replay attacks for admin messages.

bytes session_passkey = 101;

clearSetCannedMessageModuleMessages

open fun clearSetCannedMessageModuleMessages(): AdminProtos.AdminMessage.Builder


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

clearSetChannel

open fun clearSetChannel(): AdminProtos.AdminMessage.Builder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

clearSetConfig

open fun clearSetConfig(): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.Config set_config = 34;

clearSetFavoriteNode

open fun clearSetFavoriteNode(): AdminProtos.AdminMessage.Builder


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

clearSetFixedPosition

open fun clearSetFixedPosition(): AdminProtos.AdminMessage.Builder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

clearSetHamMode

open fun clearSetHamMode(): AdminProtos.AdminMessage.Builder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

clearSetIgnoredNode

open fun clearSetIgnoredNode(): AdminProtos.AdminMessage.Builder


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

clearSetModuleConfig

open fun clearSetModuleConfig(): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

clearSetOwner

open fun clearSetOwner(): AdminProtos.AdminMessage.Builder


Set the owner for this node

.meshtastic.User set_owner = 32;

clearSetRingtoneMessage

open fun clearSetRingtoneMessage(): AdminProtos.AdminMessage.Builder


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

clearSetScale

open fun clearSetScale(): AdminProtos.AdminMessage.Builder


Set zero and offset for scale chips

uint32 set_scale = 23;

clearSetTimeOnly

open fun clearSetTimeOnly(): AdminProtos.AdminMessage.Builder


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

clearShutdownSeconds

open fun clearShutdownSeconds(): AdminProtos.AdminMessage.Builder


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

clearStoreUiConfig

open fun clearStoreUiConfig(): AdminProtos.AdminMessage.Builder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

getAddContact

open fun getAddContact(): AdminProtos.SharedContact


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

getAddContactBuilder

open fun getAddContactBuilder(): AdminProtos.SharedContact.Builder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

getAddContactOrBuilder

open fun getAddContactOrBuilder(): AdminProtos.SharedContactOrBuilder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

getBackupPreferences

open fun getBackupPreferences(): AdminProtos.AdminMessage.BackupLocation


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

getBackupPreferencesValue

open fun getBackupPreferencesValue(): Int


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

getBeginEditSettings

open fun getBeginEditSettings(): Boolean


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

getCommitEditSettings

open fun getCommitEditSettings(): Boolean


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

getDefaultInstanceForType

open fun getDefaultInstanceForType(): AdminProtos.AdminMessage

getDeleteFileRequest

open fun getDeleteFileRequest(): String


Delete the file by the specified path from the device

string delete_file_request = 22;

getDeleteFileRequestBytes

open fun getDeleteFileRequestBytes(): ByteString


Delete the file by the specified path from the device

string delete_file_request = 22;

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getEnterDfuModeRequest

open fun getEnterDfuModeRequest(): Boolean


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

getExitSimulator

open fun getExitSimulator(): Boolean


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

getFactoryResetConfig

open fun getFactoryResetConfig(): Int


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

getFactoryResetDevice

open fun getFactoryResetDevice(): Int


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

getGetCannedMessageModuleMessagesRequest

open fun getGetCannedMessageModuleMessagesRequest(): Boolean


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

getGetCannedMessageModuleMessagesResponse

open fun getGetCannedMessageModuleMessagesResponse(): String


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

getGetCannedMessageModuleMessagesResponseBytes

open fun getGetCannedMessageModuleMessagesResponseBytes(): ByteString


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

getGetChannelRequest

open fun getGetChannelRequest(): Int


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

getGetChannelResponse

open fun getGetChannelResponse(): ChannelProtos.Channel


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

getGetChannelResponseBuilder

open fun getGetChannelResponseBuilder(): ChannelProtos.Channel.Builder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

getGetChannelResponseOrBuilder

open fun getGetChannelResponseOrBuilder(): ChannelProtos.ChannelOrBuilder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

getGetConfigRequest

open fun getGetConfigRequest(): AdminProtos.AdminMessage.ConfigType


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

getGetConfigRequestValue

open fun getGetConfigRequestValue(): Int


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

getGetConfigResponse

open fun getGetConfigResponse(): ConfigProtos.Config


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

getGetConfigResponseBuilder

open fun getGetConfigResponseBuilder(): ConfigProtos.Config.Builder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

getGetConfigResponseOrBuilder

open fun getGetConfigResponseOrBuilder(): ConfigProtos.ConfigOrBuilder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

getGetDeviceConnectionStatusRequest

open fun getGetDeviceConnectionStatusRequest(): Boolean


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

getGetDeviceConnectionStatusResponse

open fun getGetDeviceConnectionStatusResponse(): ConnStatusProtos.DeviceConnectionStatus


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

getGetDeviceConnectionStatusResponseBuilder

open fun getGetDeviceConnectionStatusResponseBuilder(): ConnStatusProtos.DeviceConnectionStatus.Builder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

getGetDeviceConnectionStatusResponseOrBuilder

open fun getGetDeviceConnectionStatusResponseOrBuilder(): ConnStatusProtos.DeviceConnectionStatusOrBuilder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

getGetDeviceMetadataRequest

open fun getGetDeviceMetadataRequest(): Boolean


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

getGetDeviceMetadataResponse

open fun getGetDeviceMetadataResponse(): MeshProtos.DeviceMetadata


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

getGetDeviceMetadataResponseBuilder

open fun getGetDeviceMetadataResponseBuilder(): MeshProtos.DeviceMetadata.Builder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

getGetDeviceMetadataResponseOrBuilder

open fun getGetDeviceMetadataResponseOrBuilder(): MeshProtos.DeviceMetadataOrBuilder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

getGetModuleConfigRequest

open fun getGetModuleConfigRequest(): AdminProtos.AdminMessage.ModuleConfigType


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

getGetModuleConfigRequestValue

open fun getGetModuleConfigRequestValue(): Int


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

getGetModuleConfigResponse

open fun getGetModuleConfigResponse(): ModuleConfigProtos.ModuleConfig


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

getGetModuleConfigResponseBuilder

open fun getGetModuleConfigResponseBuilder(): ModuleConfigProtos.ModuleConfig.Builder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

getGetModuleConfigResponseOrBuilder

open fun getGetModuleConfigResponseOrBuilder(): ModuleConfigProtos.ModuleConfigOrBuilder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

getGetNodeRemoteHardwarePinsRequest

open fun getGetNodeRemoteHardwarePinsRequest(): Boolean


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

getGetNodeRemoteHardwarePinsResponse

open fun getGetNodeRemoteHardwarePinsResponse(): AdminProtos.NodeRemoteHardwarePinsResponse


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

getGetNodeRemoteHardwarePinsResponseBuilder

open fun getGetNodeRemoteHardwarePinsResponseBuilder(): AdminProtos.NodeRemoteHardwarePinsResponse.Builder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

getGetNodeRemoteHardwarePinsResponseOrBuilder

open fun getGetNodeRemoteHardwarePinsResponseOrBuilder(): AdminProtos.NodeRemoteHardwarePinsResponseOrBuilder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

getGetOwnerRequest

open fun getGetOwnerRequest(): Boolean


Send the current owner data in the response to this message.

bool get_owner_request = 3;

getGetOwnerResponse

open fun getGetOwnerResponse(): MeshProtos.User


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

getGetOwnerResponseBuilder

open fun getGetOwnerResponseBuilder(): MeshProtos.User.Builder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

getGetOwnerResponseOrBuilder

open fun getGetOwnerResponseOrBuilder(): MeshProtos.UserOrBuilder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

getGetRingtoneRequest

open fun getGetRingtoneRequest(): Boolean


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

getGetRingtoneResponse

open fun getGetRingtoneResponse(): String


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

getGetRingtoneResponseBytes

open fun getGetRingtoneResponseBytes(): ByteString


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

getGetUiConfigRequest

open fun getGetUiConfigRequest(): Boolean


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

getGetUiConfigResponse

open fun getGetUiConfigResponse(): DeviceUIProtos.DeviceUIConfig


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

getGetUiConfigResponseBuilder

open fun getGetUiConfigResponseBuilder(): DeviceUIProtos.DeviceUIConfig.Builder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

getGetUiConfigResponseOrBuilder

open fun getGetUiConfigResponseOrBuilder(): DeviceUIProtos.DeviceUIConfigOrBuilder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

getKeyVerification

open fun getKeyVerification(): AdminProtos.KeyVerificationAdmin


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

getKeyVerificationBuilder

open fun getKeyVerificationBuilder(): AdminProtos.KeyVerificationAdmin.Builder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

getKeyVerificationOrBuilder

open fun getKeyVerificationOrBuilder(): AdminProtos.KeyVerificationAdminOrBuilder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

getNodedbReset

open fun getNodedbReset(): Int


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

getPayloadVariantCase

open fun getPayloadVariantCase(): AdminProtos.AdminMessage.PayloadVariantCase

getRebootOtaSeconds

open fun getRebootOtaSeconds(): Int


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

getRebootSeconds

open fun getRebootSeconds(): Int


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

getRemoveBackupPreferences

open fun getRemoveBackupPreferences(): AdminProtos.AdminMessage.BackupLocation


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

getRemoveBackupPreferencesValue

open fun getRemoveBackupPreferencesValue(): Int


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

getRemoveByNodenum

open fun getRemoveByNodenum(): Int


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

getRemoveFavoriteNode

open fun getRemoveFavoriteNode(): Int


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

getRemoveFixedPosition

open fun getRemoveFixedPosition(): Boolean


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

getRemoveIgnoredNode

open fun getRemoveIgnoredNode(): Int


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

getRestorePreferences

open fun getRestorePreferences(): AdminProtos.AdminMessage.BackupLocation


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

getRestorePreferencesValue

open fun getRestorePreferencesValue(): Int


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

getSendInputEvent

open fun getSendInputEvent(): AdminProtos.AdminMessage.InputEvent


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

getSendInputEventBuilder

open fun getSendInputEventBuilder(): AdminProtos.AdminMessage.InputEvent.Builder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

getSendInputEventOrBuilder

open fun getSendInputEventOrBuilder(): AdminProtos.AdminMessage.InputEventOrBuilder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

getSessionPasskey

open fun getSessionPasskey(): ByteString


The node generates this key and sends it with any get_x_response packets.
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
Prevents replay attacks for admin messages.

bytes session_passkey = 101;

getSetCannedMessageModuleMessages

open fun getSetCannedMessageModuleMessages(): String


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

getSetCannedMessageModuleMessagesBytes

open fun getSetCannedMessageModuleMessagesBytes(): ByteString


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

getSetChannel

open fun getSetChannel(): ChannelProtos.Channel


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

getSetChannelBuilder

open fun getSetChannelBuilder(): ChannelProtos.Channel.Builder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

getSetChannelOrBuilder

open fun getSetChannelOrBuilder(): ChannelProtos.ChannelOrBuilder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

getSetConfig

open fun getSetConfig(): ConfigProtos.Config


Set the current Config

.meshtastic.Config set_config = 34;

getSetConfigBuilder

open fun getSetConfigBuilder(): ConfigProtos.Config.Builder


Set the current Config

.meshtastic.Config set_config = 34;

getSetConfigOrBuilder

open fun getSetConfigOrBuilder(): ConfigProtos.ConfigOrBuilder


Set the current Config

.meshtastic.Config set_config = 34;

getSetFavoriteNode

open fun getSetFavoriteNode(): Int


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

getSetFixedPosition

open fun getSetFixedPosition(): MeshProtos.Position


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

getSetFixedPositionBuilder

open fun getSetFixedPositionBuilder(): MeshProtos.Position.Builder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

getSetFixedPositionOrBuilder

open fun getSetFixedPositionOrBuilder(): MeshProtos.PositionOrBuilder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

getSetHamMode

open fun getSetHamMode(): AdminProtos.HamParameters


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

getSetHamModeBuilder

open fun getSetHamModeBuilder(): AdminProtos.HamParameters.Builder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

getSetHamModeOrBuilder

open fun getSetHamModeOrBuilder(): AdminProtos.HamParametersOrBuilder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

getSetIgnoredNode

open fun getSetIgnoredNode(): Int


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

getSetModuleConfig

open fun getSetModuleConfig(): ModuleConfigProtos.ModuleConfig


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

getSetModuleConfigBuilder

open fun getSetModuleConfigBuilder(): ModuleConfigProtos.ModuleConfig.Builder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

getSetModuleConfigOrBuilder

open fun getSetModuleConfigOrBuilder(): ModuleConfigProtos.ModuleConfigOrBuilder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

getSetOwner

open fun getSetOwner(): MeshProtos.User


Set the owner for this node

.meshtastic.User set_owner = 32;

getSetOwnerBuilder

open fun getSetOwnerBuilder(): MeshProtos.User.Builder


Set the owner for this node

.meshtastic.User set_owner = 32;

getSetOwnerOrBuilder

open fun getSetOwnerOrBuilder(): MeshProtos.UserOrBuilder


Set the owner for this node

.meshtastic.User set_owner = 32;

getSetRingtoneMessage

open fun getSetRingtoneMessage(): String


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

getSetRingtoneMessageBytes

open fun getSetRingtoneMessageBytes(): ByteString


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

getSetScale

open fun getSetScale(): Int


Set zero and offset for scale chips

uint32 set_scale = 23;

getSetTimeOnly

open fun getSetTimeOnly(): Int


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

getShutdownSeconds

open fun getShutdownSeconds(): Int


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

getStoreUiConfig

open fun getStoreUiConfig(): DeviceUIProtos.DeviceUIConfig


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

getStoreUiConfigBuilder

open fun getStoreUiConfigBuilder(): DeviceUIProtos.DeviceUIConfig.Builder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

getStoreUiConfigOrBuilder

open fun getStoreUiConfigOrBuilder(): DeviceUIProtos.DeviceUIConfigOrBuilder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

hasAddContact

open fun hasAddContact(): Boolean


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

hasBackupPreferences

open fun hasBackupPreferences(): Boolean


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

hasBeginEditSettings

open fun hasBeginEditSettings(): Boolean


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

hasCommitEditSettings

open fun hasCommitEditSettings(): Boolean


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

hasDeleteFileRequest

open fun hasDeleteFileRequest(): Boolean


Delete the file by the specified path from the device

string delete_file_request = 22;

hasEnterDfuModeRequest

open fun hasEnterDfuModeRequest(): Boolean


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

hasExitSimulator

open fun hasExitSimulator(): Boolean


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

hasFactoryResetConfig

open fun hasFactoryResetConfig(): Boolean


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

hasFactoryResetDevice

open fun hasFactoryResetDevice(): Boolean


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

hasGetCannedMessageModuleMessagesRequest

open fun hasGetCannedMessageModuleMessagesRequest(): Boolean


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

hasGetCannedMessageModuleMessagesResponse

open fun hasGetCannedMessageModuleMessagesResponse(): Boolean


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

hasGetChannelRequest

open fun hasGetChannelRequest(): Boolean


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

hasGetChannelResponse

open fun hasGetChannelResponse(): Boolean


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

hasGetConfigRequest

open fun hasGetConfigRequest(): Boolean


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

hasGetConfigResponse

open fun hasGetConfigResponse(): Boolean


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

hasGetDeviceConnectionStatusRequest

open fun hasGetDeviceConnectionStatusRequest(): Boolean


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

hasGetDeviceConnectionStatusResponse

open fun hasGetDeviceConnectionStatusResponse(): Boolean


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

hasGetDeviceMetadataRequest

open fun hasGetDeviceMetadataRequest(): Boolean


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

hasGetDeviceMetadataResponse

open fun hasGetDeviceMetadataResponse(): Boolean


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

hasGetModuleConfigRequest

open fun hasGetModuleConfigRequest(): Boolean


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

hasGetModuleConfigResponse

open fun hasGetModuleConfigResponse(): Boolean


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

hasGetNodeRemoteHardwarePinsRequest

open fun hasGetNodeRemoteHardwarePinsRequest(): Boolean


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

hasGetNodeRemoteHardwarePinsResponse

open fun hasGetNodeRemoteHardwarePinsResponse(): Boolean


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

hasGetOwnerRequest

open fun hasGetOwnerRequest(): Boolean


Send the current owner data in the response to this message.

bool get_owner_request = 3;

hasGetOwnerResponse

open fun hasGetOwnerResponse(): Boolean


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

hasGetRingtoneRequest

open fun hasGetRingtoneRequest(): Boolean


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

hasGetRingtoneResponse

open fun hasGetRingtoneResponse(): Boolean


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

hasGetUiConfigRequest

open fun hasGetUiConfigRequest(): Boolean


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

hasGetUiConfigResponse

open fun hasGetUiConfigResponse(): Boolean


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

hasKeyVerification

open fun hasKeyVerification(): Boolean


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

hasNodedbReset

open fun hasNodedbReset(): Boolean


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

hasRebootOtaSeconds

open fun hasRebootOtaSeconds(): Boolean


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

hasRebootSeconds

open fun hasRebootSeconds(): Boolean


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

hasRemoveBackupPreferences

open fun hasRemoveBackupPreferences(): Boolean


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

hasRemoveByNodenum

open fun hasRemoveByNodenum(): Boolean


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

hasRemoveFavoriteNode

open fun hasRemoveFavoriteNode(): Boolean


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

hasRemoveFixedPosition

open fun hasRemoveFixedPosition(): Boolean


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

hasRemoveIgnoredNode

open fun hasRemoveIgnoredNode(): Boolean


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

hasRestorePreferences

open fun hasRestorePreferences(): Boolean


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

hasSendInputEvent

open fun hasSendInputEvent(): Boolean


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

hasSetCannedMessageModuleMessages

open fun hasSetCannedMessageModuleMessages(): Boolean


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

hasSetChannel

open fun hasSetChannel(): Boolean


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

hasSetConfig

open fun hasSetConfig(): Boolean


Set the current Config

.meshtastic.Config set_config = 34;

hasSetFavoriteNode

open fun hasSetFavoriteNode(): Boolean


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

hasSetFixedPosition

open fun hasSetFixedPosition(): Boolean


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

hasSetHamMode

open fun hasSetHamMode(): Boolean


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

hasSetIgnoredNode

open fun hasSetIgnoredNode(): Boolean


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

hasSetModuleConfig

open fun hasSetModuleConfig(): Boolean


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

hasSetOwner

open fun hasSetOwner(): Boolean


Set the owner for this node

.meshtastic.User set_owner = 32;

hasSetRingtoneMessage

open fun hasSetRingtoneMessage(): Boolean


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

hasSetScale

open fun hasSetScale(): Boolean


Set zero and offset for scale chips

uint32 set_scale = 23;

hasSetTimeOnly

open fun hasSetTimeOnly(): Boolean


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

hasShutdownSeconds

open fun hasShutdownSeconds(): Boolean


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

hasStoreUiConfig

open fun hasStoreUiConfig(): Boolean


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

isInitialized

fun isInitialized(): Boolean

mergeAddContact

open fun mergeAddContact(value: AdminProtos.SharedContact): AdminProtos.AdminMessage.Builder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

mergeFrom

open fun mergeFrom(other: AdminProtos.AdminMessage): AdminProtos.AdminMessage.Builder

open fun mergeFrom(other: Message): AdminProtos.AdminMessage.Builder

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage.Builder

mergeGetChannelResponse

open fun mergeGetChannelResponse(value: ChannelProtos.Channel): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

mergeGetConfigResponse

open fun mergeGetConfigResponse(value: ConfigProtos.Config): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

mergeGetDeviceConnectionStatusResponse

open fun mergeGetDeviceConnectionStatusResponse(value: ConnStatusProtos.DeviceConnectionStatus): AdminProtos.AdminMessage.Builder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

mergeGetDeviceMetadataResponse

open fun mergeGetDeviceMetadataResponse(value: MeshProtos.DeviceMetadata): AdminProtos.AdminMessage.Builder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

mergeGetModuleConfigResponse

open fun mergeGetModuleConfigResponse(value: ModuleConfigProtos.ModuleConfig): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

mergeGetNodeRemoteHardwarePinsResponse

open fun mergeGetNodeRemoteHardwarePinsResponse(value: AdminProtos.NodeRemoteHardwarePinsResponse): AdminProtos.AdminMessage.Builder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

mergeGetOwnerResponse

open fun mergeGetOwnerResponse(value: MeshProtos.User): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

mergeGetUiConfigResponse

open fun mergeGetUiConfigResponse(value: DeviceUIProtos.DeviceUIConfig): AdminProtos.AdminMessage.Builder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

mergeKeyVerification

open fun mergeKeyVerification(value: AdminProtos.KeyVerificationAdmin): AdminProtos.AdminMessage.Builder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

mergeSendInputEvent

open fun mergeSendInputEvent(value: AdminProtos.AdminMessage.InputEvent): AdminProtos.AdminMessage.Builder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

mergeSetChannel

open fun mergeSetChannel(value: ChannelProtos.Channel): AdminProtos.AdminMessage.Builder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

mergeSetConfig

open fun mergeSetConfig(value: ConfigProtos.Config): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.Config set_config = 34;

mergeSetFixedPosition

open fun mergeSetFixedPosition(value: MeshProtos.Position): AdminProtos.AdminMessage.Builder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

mergeSetHamMode

open fun mergeSetHamMode(value: AdminProtos.HamParameters): AdminProtos.AdminMessage.Builder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

mergeSetModuleConfig

open fun mergeSetModuleConfig(value: ModuleConfigProtos.ModuleConfig): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

mergeSetOwner

open fun mergeSetOwner(value: MeshProtos.User): AdminProtos.AdminMessage.Builder


Set the owner for this node

.meshtastic.User set_owner = 32;

mergeStoreUiConfig

open fun mergeStoreUiConfig(value: DeviceUIProtos.DeviceUIConfig): AdminProtos.AdminMessage.Builder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

setAddContact

open fun setAddContact(value: AdminProtos.SharedContact): AdminProtos.AdminMessage.Builder

open fun setAddContact(builderForValue: AdminProtos.SharedContact.Builder): AdminProtos.AdminMessage.Builder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

setBackupPreferences

open fun setBackupPreferences(value: AdminProtos.AdminMessage.BackupLocation): AdminProtos.AdminMessage.Builder


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

setBackupPreferencesValue

open fun setBackupPreferencesValue(value: Int): AdminProtos.AdminMessage.Builder


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

setBeginEditSettings

open fun setBeginEditSettings(value: Boolean): AdminProtos.AdminMessage.Builder


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

setCommitEditSettings

open fun setCommitEditSettings(value: Boolean): AdminProtos.AdminMessage.Builder


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

setDeleteFileRequest

open fun setDeleteFileRequest(value: String): AdminProtos.AdminMessage.Builder


Delete the file by the specified path from the device

string delete_file_request = 22;

setDeleteFileRequestBytes

open fun setDeleteFileRequestBytes(value: ByteString): AdminProtos.AdminMessage.Builder


Delete the file by the specified path from the device

string delete_file_request = 22;

setEnterDfuModeRequest

open fun setEnterDfuModeRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

setExitSimulator

open fun setExitSimulator(value: Boolean): AdminProtos.AdminMessage.Builder


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

setFactoryResetConfig

open fun setFactoryResetConfig(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

setFactoryResetDevice

open fun setFactoryResetDevice(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

setGetCannedMessageModuleMessagesRequest

open fun setGetCannedMessageModuleMessagesRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

setGetCannedMessageModuleMessagesResponse

open fun setGetCannedMessageModuleMessagesResponse(value: String): AdminProtos.AdminMessage.Builder


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

setGetCannedMessageModuleMessagesResponseBytes

open fun setGetCannedMessageModuleMessagesResponseBytes(value: ByteString): AdminProtos.AdminMessage.Builder


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

setGetChannelRequest

open fun setGetChannelRequest(value: Int): AdminProtos.AdminMessage.Builder


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

setGetChannelResponse

open fun setGetChannelResponse(value: ChannelProtos.Channel): AdminProtos.AdminMessage.Builder

open fun setGetChannelResponse(builderForValue: ChannelProtos.Channel.Builder): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

setGetConfigRequest

open fun setGetConfigRequest(value: AdminProtos.AdminMessage.ConfigType): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

setGetConfigRequestValue

open fun setGetConfigRequestValue(value: Int): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

setGetConfigResponse

open fun setGetConfigResponse(value: ConfigProtos.Config): AdminProtos.AdminMessage.Builder

open fun setGetConfigResponse(builderForValue: ConfigProtos.Config.Builder): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

setGetDeviceConnectionStatusRequest

open fun setGetDeviceConnectionStatusRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

setGetDeviceConnectionStatusResponse

open fun setGetDeviceConnectionStatusResponse(value: ConnStatusProtos.DeviceConnectionStatus): AdminProtos.AdminMessage.Builder

open fun setGetDeviceConnectionStatusResponse(builderForValue: ConnStatusProtos.DeviceConnectionStatus.Builder): AdminProtos.AdminMessage.Builder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

setGetDeviceMetadataRequest

open fun setGetDeviceMetadataRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

setGetDeviceMetadataResponse

open fun setGetDeviceMetadataResponse(value: MeshProtos.DeviceMetadata): AdminProtos.AdminMessage.Builder

open fun setGetDeviceMetadataResponse(builderForValue: MeshProtos.DeviceMetadata.Builder): AdminProtos.AdminMessage.Builder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

setGetModuleConfigRequest

open fun setGetModuleConfigRequest(value: AdminProtos.AdminMessage.ModuleConfigType): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

setGetModuleConfigRequestValue

open fun setGetModuleConfigRequestValue(value: Int): AdminProtos.AdminMessage.Builder


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

setGetModuleConfigResponse

open fun setGetModuleConfigResponse(value: ModuleConfigProtos.ModuleConfig): AdminProtos.AdminMessage.Builder

open fun setGetModuleConfigResponse(builderForValue: ModuleConfigProtos.ModuleConfig.Builder): AdminProtos.AdminMessage.Builder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

setGetNodeRemoteHardwarePinsRequest

open fun setGetNodeRemoteHardwarePinsRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

setGetNodeRemoteHardwarePinsResponse

open fun setGetNodeRemoteHardwarePinsResponse(value: AdminProtos.NodeRemoteHardwarePinsResponse): AdminProtos.AdminMessage.Builder

open fun setGetNodeRemoteHardwarePinsResponse(builderForValue: AdminProtos.NodeRemoteHardwarePinsResponse.Builder): AdminProtos.AdminMessage.Builder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

setGetOwnerRequest

open fun setGetOwnerRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Send the current owner data in the response to this message.

bool get_owner_request = 3;

setGetOwnerResponse

open fun setGetOwnerResponse(value: MeshProtos.User): AdminProtos.AdminMessage.Builder

open fun setGetOwnerResponse(builderForValue: MeshProtos.User.Builder): AdminProtos.AdminMessage.Builder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

setGetRingtoneRequest

open fun setGetRingtoneRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

setGetRingtoneResponse

open fun setGetRingtoneResponse(value: String): AdminProtos.AdminMessage.Builder


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

setGetRingtoneResponseBytes

open fun setGetRingtoneResponseBytes(value: ByteString): AdminProtos.AdminMessage.Builder


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

setGetUiConfigRequest

open fun setGetUiConfigRequest(value: Boolean): AdminProtos.AdminMessage.Builder


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

setGetUiConfigResponse

open fun setGetUiConfigResponse(value: DeviceUIProtos.DeviceUIConfig): AdminProtos.AdminMessage.Builder

open fun setGetUiConfigResponse(builderForValue: DeviceUIProtos.DeviceUIConfig.Builder): AdminProtos.AdminMessage.Builder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

setKeyVerification

open fun setKeyVerification(value: AdminProtos.KeyVerificationAdmin): AdminProtos.AdminMessage.Builder

open fun setKeyVerification(builderForValue: AdminProtos.KeyVerificationAdmin.Builder): AdminProtos.AdminMessage.Builder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

setNodedbReset

open fun setNodedbReset(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

setRebootOtaSeconds

open fun setRebootOtaSeconds(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

setRebootSeconds

open fun setRebootSeconds(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

setRemoveBackupPreferences

open fun setRemoveBackupPreferences(value: AdminProtos.AdminMessage.BackupLocation): AdminProtos.AdminMessage.Builder


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

setRemoveBackupPreferencesValue

open fun setRemoveBackupPreferencesValue(value: Int): AdminProtos.AdminMessage.Builder


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

setRemoveByNodenum

open fun setRemoveByNodenum(value: Int): AdminProtos.AdminMessage.Builder


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

setRemoveFavoriteNode

open fun setRemoveFavoriteNode(value: Int): AdminProtos.AdminMessage.Builder


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

setRemoveFixedPosition

open fun setRemoveFixedPosition(value: Boolean): AdminProtos.AdminMessage.Builder


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

setRemoveIgnoredNode

open fun setRemoveIgnoredNode(value: Int): AdminProtos.AdminMessage.Builder


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

setRestorePreferences

open fun setRestorePreferences(value: AdminProtos.AdminMessage.BackupLocation): AdminProtos.AdminMessage.Builder


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

setRestorePreferencesValue

open fun setRestorePreferencesValue(value: Int): AdminProtos.AdminMessage.Builder


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

setSendInputEvent

open fun setSendInputEvent(value: AdminProtos.AdminMessage.InputEvent): AdminProtos.AdminMessage.Builder

open fun setSendInputEvent(builderForValue: AdminProtos.AdminMessage.InputEvent.Builder): AdminProtos.AdminMessage.Builder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

setSessionPasskey

open fun setSessionPasskey(value: ByteString): AdminProtos.AdminMessage.Builder


The node generates this key and sends it with any get_x_response packets.
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
Prevents replay attacks for admin messages.

bytes session_passkey = 101;

setSetCannedMessageModuleMessages

open fun setSetCannedMessageModuleMessages(value: String): AdminProtos.AdminMessage.Builder


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

setSetCannedMessageModuleMessagesBytes

open fun setSetCannedMessageModuleMessagesBytes(value: ByteString): AdminProtos.AdminMessage.Builder


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

setSetChannel

open fun setSetChannel(value: ChannelProtos.Channel): AdminProtos.AdminMessage.Builder

open fun setSetChannel(builderForValue: ChannelProtos.Channel.Builder): AdminProtos.AdminMessage.Builder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

setSetConfig

open fun setSetConfig(value: ConfigProtos.Config): AdminProtos.AdminMessage.Builder

open fun setSetConfig(builderForValue: ConfigProtos.Config.Builder): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.Config set_config = 34;

setSetFavoriteNode

open fun setSetFavoriteNode(value: Int): AdminProtos.AdminMessage.Builder


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

setSetFixedPosition

open fun setSetFixedPosition(value: MeshProtos.Position): AdminProtos.AdminMessage.Builder

open fun setSetFixedPosition(builderForValue: MeshProtos.Position.Builder): AdminProtos.AdminMessage.Builder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

setSetHamMode

open fun setSetHamMode(value: AdminProtos.HamParameters): AdminProtos.AdminMessage.Builder

open fun setSetHamMode(builderForValue: AdminProtos.HamParameters.Builder): AdminProtos.AdminMessage.Builder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

setSetIgnoredNode

open fun setSetIgnoredNode(value: Int): AdminProtos.AdminMessage.Builder


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

setSetModuleConfig

open fun setSetModuleConfig(value: ModuleConfigProtos.ModuleConfig): AdminProtos.AdminMessage.Builder

open fun setSetModuleConfig(builderForValue: ModuleConfigProtos.ModuleConfig.Builder): AdminProtos.AdminMessage.Builder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

setSetOwner

open fun setSetOwner(value: MeshProtos.User): AdminProtos.AdminMessage.Builder

open fun setSetOwner(builderForValue: MeshProtos.User.Builder): AdminProtos.AdminMessage.Builder


Set the owner for this node

.meshtastic.User set_owner = 32;

setSetRingtoneMessage

open fun setSetRingtoneMessage(value: String): AdminProtos.AdminMessage.Builder


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

setSetRingtoneMessageBytes

open fun setSetRingtoneMessageBytes(value: ByteString): AdminProtos.AdminMessage.Builder


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

setSetScale

open fun setSetScale(value: Int): AdminProtos.AdminMessage.Builder


Set zero and offset for scale chips

uint32 set_scale = 23;

setSetTimeOnly

open fun setSetTimeOnly(value: Int): AdminProtos.AdminMessage.Builder


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

setShutdownSeconds

open fun setShutdownSeconds(value: Int): AdminProtos.AdminMessage.Builder


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

setStoreUiConfig

open fun setStoreUiConfig(value: DeviceUIProtos.DeviceUIConfig): AdminProtos.AdminMessage.Builder

open fun setStoreUiConfig(builderForValue: DeviceUIProtos.DeviceUIConfig.Builder): AdminProtos.AdminMessage.Builder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;